/*
 * Copyright (c) 2011 Sapienza University of Rome.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the
 *   distribution.
 * - Neither the name of the Sapienza University of Rome nor the names of
 *   its contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL SAPIENZA
 * UNIVERSITY OF ROME OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/**
 * This interface, implemented by the ManagerC component, is used to avoid
 * that the Lpl interface interfere with the active phase of DISSense (the active
 * phase must be very quick, thus it cannot wait for a resource that is busy for
 * Lpl).
 * In particular it checks, whenever an LPL request is pending, if DISSense
 * is running the active phase or if there isenough time to process an Lpl request
 * before the active phase begins.
 *
 * @author Ugo Colesanti <colesanti@dis.uniroma1.it>
 * @version 1.01 (September 28, 2011)
 *
 */
interface ProtocolScheduler{

	/**
	 * Ask the ManagerC component if we are free to send an Lpl sync message
	 * (it first checks if it is InSync, then if it is not running the active phase and if there is
	 * at least t milliseconds before the beginning of the active phase).
	 * @param time The time required (in milliseconds) to process the Lpl task.
	 */
	command bool allowLplSyncResponse(uint16_t time) ;

	/**
	 * Ask the ManagerC component if we are free to send an Lpl sync request
	 * (it first checks if it is out of synchronization, then if it is in a valid out of sync state.
	 */
	command bool allowLplSyncRequest() ;

	/**
	 * Notify the ManagerC component that the sync response has been sent.
	 */
	command void syncResponseSendDone() ;

	/**
	 * Notify the ManagerC component that the sync request has been sent.
	 */
	command void syncRequestSendDone() ;

}
